/*
 * Copyright (c) 2008 Benoit Bouchez, Nicolas Giard
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
package com.noocodecommit.wicket.stuff.jquery.behavior;

import org.apache.wicket.Component;
import org.apache.wicket.MarkupContainer;
import org.apache.wicket.Component.IVisitor;
import org.apache.wicket.ajax.AbstractDefaultAjaxBehavior;

/**
 * Abstract JQuery Ajax Behavior
 * 
 * @author Benoit Bouchez
 * 
 */
public abstract class AbstractDefaultJQBehavior extends AbstractDefaultAjaxBehavior
{
	private boolean checkPrecondition;

	/**
	 * Constructor
	 */
	public AbstractDefaultJQBehavior()
	{
		this(true);
	}

	/**
	 * Constructor
	 * 
	 * @param checkPrecondition
	 *            if true, the behavior will check the existence of the component it is binded.<br>
	 *            if the component does not exists, wicketAjaxGet will not execute.<br>
	 *            false is typical use for behaviors which don't need components to bind. (e.g. JQuery javascript callback functions)
	 */
	public AbstractDefaultJQBehavior(boolean checkPrecondition)
	{
		super();
		this.checkPrecondition = checkPrecondition;
	}

	@Override
	public CharSequence getCallbackScript()
	{
		return generateCallbackScript("wicketAjaxGet('" + getCallbackUrl(onlyTargetActivePage()) + "'");
	}

	@Override
	protected CharSequence getPreconditionScript()
	{
		if (this.checkPrecondition)
		{
			return super.getPreconditionScript();
		}
		else
		{
			return "return true;";
		}
	}

	protected boolean onlyTargetActivePage()
	{
		return true;
	}

	/**
	 * Inner class used to find a component
	 * 
	 * @author Benoit Bouchez
	 * 
	 */
	public static class MarkupIdVisitor implements IVisitor
	{
		private final String id;
		private Component found;

		/**
		 * Constructor
		 * 
		 * @param id
		 *            component id
		 */
		public MarkupIdVisitor(String id)
		{
			this.id = id;
		}

		public Object component(Component component)
		{
			if (component.getMarkupId().equals(id))
			{
				this.found = component;
				return IVisitor.STOP_TRAVERSAL;
			}
			if (component instanceof MarkupContainer)
			{
				return ((MarkupContainer) component).visitChildren(this);
			}
			return IVisitor.CONTINUE_TRAVERSAL;
		}

		/**
		 * Gets visitor found component
		 * 
		 * @return wicket component if found
		 */
		public Component getFoundComponent()
		{
			return found;
		}
	}
}
